Day-21 ArgoCD 介紹 - 進階功能

前言

今天會來介紹三個 ArgoCD 的進階功能

1. Sync Waves
2. Sync Windows
3. Alert & Notification

Sync Waves

在大多數情況下，系統是由多個相互依賴的服務組成的，這些服務之間常常存在依賴關係（例如 API 依賴）。因此，我們希望能夠控制每個服務的部署順序，以確保系統的 API 邏輯運行正常。

假設服務依賴性如下

graph LR;
    app-backend---|API dependency|product-backend
    product-backend---|API dependency|payment-backend

我們希望的部署順序為：

1. 先部署 payment-backend
2. 等 payment-backend 部署完成後，再部署 production-backend
3. 最後部署 app-backend

這樣只要租巡 每個服務都 API 都向前兼容一個版本 的開發原則，就能保證服務不會中斷或出錯，避免發佈維護或停機措施。

透過 ArgoCD 的 Sync Waves 的功能，使用 argocd.argoproj.io/sync-wave 的 annotation 來指定部署順序

metadata:
  annotations:
    argocd.argoproj.io/sync-wave: "5"

所有 ArgoCD Application 管理的資源，預設 argocd.argoproj.io/sync-wave 值為 0，部署時，會依據 argocd.argoproj.io/sync-wave 的值，來確保部署的順序性和依賴性：

• 依據 sync-wave 值，由小至大的依序進行部署
• 當上一個 sync-wave 都部署成功時，才會進行下一個順位的部署。

例子

要滿足我們的部署需求，只需在資源的 YAML 文件中加入 sync-wave annotation。例如：

# payment-backend
apiVersion: apps/v1
kind: Deployment
metadata:
  name: payment-backend
  annotations:
    argocd.argoproj.io/sync-wave: "-10"

# product-backend
apiVersion: apps/v1
kind: Deployment
metadata:
  name: product-backend
  annotations:
    argocd.argoproj.io/sync-wave: "-5"

# app-backend
apiVersion: apps/v1
kind: Deployment
metadata:
  name: app-backend
  annotations:
    argocd.argoproj.io/sync-wave: "0" # 同 sync-wave 預設值 0

當 ArgoCD 開始同步時，會遵循配置有以下行為

1. 先部署 payment-backend，因為 sync-wave 小於其他 Resournce
2. 當 payment-backend 部署成功時，觸發 product-backend 的部署
3. 最後當 product-backend 部署成功時，才觸發 app-backend 部署

透過 Sync Waves 讓我們能靈活的且安全的使用 ArgoCD，確保相依的資源已正確部署，避免在依賴未準備好時就啟動應用，從而減少應用失敗的風險。

範例 YAML 能參閱GitHub

Sync Windows

Sync Windows 是用來控制何時允許或禁止資源同步的功能，適合在特定時間範圍內進行自動化資源同步，或阻止同步操作。例如，你可以在業務高峰期禁止更新，或者為了合規需求，僅允許在指定時段進行應用部署。

Sync Windows 通常配置在 ArgoCD 的 AppProject 中，範例如下

apiVersion: argoproj.io/v1alpha1
kind: AppProject
metadata:
  name: default
spec:
  syncWindows:
  - kind: allow
    schedule: '10 1 * * *'
    duration: 1h
    applications:
    - '*-prod'
    manualSync: true
  - kind: deny
    schedule: '0 22 * * *'
    timeZone: "Europe/Amsterdam"
    duration: 1h
    namespaces:
    - default
  - kind: allow
    schedule: '0 23 * * *'
    duration: 1h
    clusters:
    - in-cluster
    - cluster1

配置說明：

• kind： allow 為允許該窗口進行同步，反之 deny 為不允許
  • schedule：使用 Cron 表達式，表達窗口的起始時間
  • duration：該窗口持續多久
  • applications：定義這個窗口控制哪些 ArgoCD Application 同步，可透過 * 模糊比對。
  • timeZone：時間根據什麼時區計算
  • namespaces：於指定的 namespace 套用該窗口
  • clusters：於指定的 clusters 套用該窗口
  • manualSync：是否允許手動同步

📘 Sync Windows 也可以通過 Web UI 進行配置。路徑為 Settings/Projects，選擇項目後進入 WINDOWS 頁籤進行管理。

透過 ArgoCD 的 Sync Windows，讓我們可以靈活控制自動化部署的時間策略，不再需要在全自動和全手動之間進行選擇。這讓部署策略更加符合業務特性或公司的政策需求。

Alert & Notification

ArgoCD 提供了許多開箱即用的 Notifications 功能，如

• Slack
• Email
• Webhook... 等等

能很輕鬆地實現告警機制，如

• Application 同步失敗
• Application health check 失敗
• 偵測到配置被更改

配置方式

Notification 配置由以下幾個概念組成：

• Templates： 通知內容的模板。
• Triggers： 通知的觸發條件。
• Subscriptions：哪些 ArgoCD Application 要訂閱該 Triggers。

這幾個配置需要定義在 ConfigMap/argocd-notifications-cm 中，例如，當生產環境的 ArgoCD Application 出現同步失敗時，要發出告警到 Slack

apiVersion: v1
kind: ConfigMap
metadata:
  name: argocd-notifications-cm
data:
  # 串接 slack 要用的 token
  service.slack: |
    token: $slack-token
  # 定義通知的內容樣板
  template.app-sync-failed: |
    message: |
      ！！出事啦！！ Application {{.app.metadata.name}} sync is {{.app.status.sync.status}}.
  # 當同步失敗時觸發通知，並使用 `app-sync-failed` 樣板作為通知內容
  trigger.on-sync-failed: |
    - description: Application syncing has failed
      send:
      - app-sync-failed
      when: app.status.operationState != nil and app.status.operationState.phase in ['Error', 'Failed']
  # 使用 selector 將有 `env=prod` Label 的 ArgoCD application 都訂閱該 Trigger，當 Trigger 觸發時，會將通知發送到 slack channel: `my-alert-channel`
  subscriptions: |
    - recipients:
      - slack:my-alert-channel
      selector: env=prod
      triggers:
      - on-sync-failed

觸發時，會看到 Slack 收到此通知

更詳細的 Notification 設定能參考官方文件/notifications

小結

在這篇文章中，我們介紹了 ArgoCD 的三個進階功能：

• Sync Waves：幫助控制應用之間的部署順序，確保有依賴關係的服務能按順序部署，減少應用部署失敗的風險。
• Sync Windows：用來控制在指定時間範圍內允許或禁止資源同步操作，非常適合應對業務高峰期或合規需求。
• Alert & Notification：提供強大的通知系統，能針對應用狀態變更（如同步失敗、配置變更等）即時發送通知到 Slack、Email 等平台。

這使得 ArgoCD 不僅僅是一個 YAML 監聽器，更能實現完善的部署策略和監控功能。

在明天的章節，我們將回顧 ArgoCD 如何改善 CI/CD Pipeline，並探討其核心優勢。

Refernce

• ArgoCD 官方文件